home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / program / inter52f.zip / INT2WHLP.ZIP / I2W-OPT.TXT < prev    next >
Text File  |  1995-12-31  |  6KB  |  119 lines
  1. INT2WHLP Interrupt List  -> WinHelp converter. 
  2.  
  3. Syntax is:
  4.     INT2WHLP [options] [InPath [options] [OutPath [options]]]
  5.  
  6. InPpath is the source file directory. The program will use INTERRUP.LST
  7. as the input file if it exists, or else it will use INTERRUP.A and consecutive
  8. INTERRUP.B, ..., . The files CATEGORY.KEY and OVERVIEW.LST should also be in
  9. the InPath directory. See also I2W-CFG.TXT's [WINDOWS] section.
  10.  
  11. OutPath is the output directory where the INTWIN.HPJ and *.RTF files will go.
  12. The program will request InPath and OutPath if they are not specified as
  13. parameters or in a configuration file.
  14.  
  15. Options are introduced by "-" or "/", and they are not case sensitive.
  16. On switch options of the form "-E+" or "-E-", actually only the "-" in
  17. position 3 is significant to turn the option off, "-E" alone or any other
  18. string after "E" turns the option on.
  19. Options taking an argument can optionally have a ":" after the option
  20. character, e.g. "-C:medium" or "-Cmedium".
  21.  
  22. All the options can also be controlled by entries in the configuration file's
  23. [OPTION] section (see I2W-OPT.TXT). Options specified as program parameters
  24. take precedence over options specified in the configuration file.
  25.  
  26. Implemented options are:
  27.     -1[+|-]        Single-entry interrupt numbers are listed directly
  28.             in the Interrupts index if this option is enabled,
  29.             instead of a reference "INT nn ..." to a one-entry
  30.             index.
  31.             Default is disabled, for a filtered list with many
  32.             single-entry interrupts enabling is preferable.
  33.             Configuration file key "singlesInMain".
  34.     -2[+|-]        The program can maintain two indexes, "Interrupt
  35.             Index" (all entries) and "Interrupts" (index with
  36.             subindexes). -2- disables Interrupt Index.
  37.             Default is enabled.
  38.             Configuration file key "twoIndexes".
  39.     -B[:]<build>    Inserts 'BUILD=<build>' in the HPJ file's [OPTIONS]
  40.             section if <build> is not the empty string. Don't
  41.             use any spaces in the <build> expression. Note
  42.                         that the OR operator "|" cannot be passed in an
  43.                         option because DOS interprets it as a pipe redirection.
  44.                         Use the configuration file if the OR operator is
  45.                         needed.
  46.                         Configuration file key "build".
  47.     -C[:][arg]    Controls HCxx's Compression ratio. If no -C option
  48.             is used, compression is set to NO. If -C or -C: is
  49.             used alone, compression is set to YES. Any argument
  50.             is passed to HCxx, legal arguments are: 0, NO, OFF
  51.             for no compression, MEDIUM for medium compression,
  52.             or 1, YES, HIGH for high compression.
  53.             Configuration file key "compression".
  54.     -E[+|-]        Controls opening of a HCxx error log file INTWIN.ERR.
  55.             Default is no error log.
  56.     -F[:]<filter>    Specifies the name of the Filter file for a partial
  57.             compilation of the Interrupt List. The filter file
  58.             must be in the current directory, or the path must
  59.             be given.
  60.             NOTE! It is recommended not to perform a partial
  61.             compilation because references to tables may then be
  62.             missing.
  63.             Configuration file key "filterFile".
  64.     -H[+|-]        Controls Headers in the Interrupt Index. If disabled,
  65.             only the entries are listed in the index. If enabled,
  66.             each new interrupt number gets a heading "INT nn ...".
  67.             Default is enabled. -H is ignored if -2- is
  68.             specified.
  69.             Configuration file key "headers".
  70.     -I[:]<columns>    Specifies the number of columns in the compressed
  71.             Index. Legal values are 1, 4, 8, or 16. Default is
  72.             1.
  73.             Configuration file key "indexColumns".
  74.     -L[+|-]        Controls whether both long and sort versions of
  75.             interrupt search keys are used, or short versions
  76.             only. A long search key is e.g. "INT 10 AH = 0", and
  77.             the correspoding short key is "10 00". Disabling long
  78.             search keys reduces the total number of keywords by
  79.             appr. 20% and can prolong the period that WinHelp 4.0
  80.             can support keyword search on intwin.hlp. WinHelp 4.0
  81.             has a limited keyword capacity.
  82.             Default is long search keys enabled.
  83.             Configuration file key "longKeys".
  84.     -M[+|-]        Controls whether or not keywords (like "See also:",
  85.             "Notes:") are marked (bolded). The program compiles
  86.             the List 20% faster, and HC31 yields a 1% shorter
  87.             .HLP file when disabled, but the readability of the
  88.             result is lower.
  89.             Default is marking enabled.
  90.             Configuration file key "markKeys".
  91.     -Q[+|-]        Controls blanks around the eQual sign in search
  92.             strings "INT nn AH = ff" or "INT nn AH=ff". Default
  93.             is blanks enabled.
  94.             Configuration file key "equalBlanks".
  95.     -R[:]<release>  The release specification controls Interrupt List
  96.             release number dependent behavior of INT2WHLP.
  97.             Implemented influence:
  98.               releaseNo<41:    Tables are not treated as separate
  99.                       topics, no table cross references.
  100.             Configuration file key "releaseNo".
  101.     -S[+|-]        Controls the Scrolling of index headers. Indexes
  102.             have a main header describing the Interrupt List,
  103.             and an individual title. If scrolling is enabled,
  104.             the title will scroll with the rest of the index,
  105.             if disabled, the title will be part of the non-
  106.             scrolling header. Scrolling is enabled by default.
  107.             Configuration file key "scrollIndexTitle".
  108.     -T[+|-]        Controls whether tables appear in a secodary
  109.             window or in the main window. The -T option is
  110.             ignored if the -R option disables separate table
  111.             topics.
  112.             Table windows are enabled by default.
  113.             Configuration file key "tableWindow".
  114.     -X[+|-]        Controls whether the Interrupt List Index initially
  115.             pops up in eXpanded (all entries in one window) or
  116.             in compressed (index with subindexes) format.
  117.             Expanded index is enabled by default.
  118.             Configuration file key "expandedIndex".
  119.